Functions Index :: D :: DefineModule

Module:

Definition:

DefineModule(string library, string package, string module)

Description:

Defines the (visible to loader) global variables that identify the module.

Arguments:

library: The name of the library where the module belongs.

package: The name of the package where the module belongs.^[1]

Notes and conditions on arguments relations:

The function is designed to be run as a "macro" ie not to assign its return value to a variable (it returns last).

Examples:

DefineModule("avslib", "debug", "core")

^[1]: The package may be further divided to an unlimited hierarchy of subpackages, if each level is separated by the "/" (slash) character.

Each slash character corresponds to a path separator in the underlying OS, thus to a nested subfolder in the package tree.

The following examples illustrate the concept:

The string "array" defines a one level hierarchy: package array (an "array" folder inside the root folder of the library's distribution).
The string "array/transforms" defines a two level hierarchy: package array, subpackage transforms (a "transforms" folder inside the "array" folder).
The string "array/transforms/affine" defines a three level hierarchy: package array, subpackage transforms (a "transforms" folder inside the "array" folder), sub-subpackage affine (an "affine" folder inside the "transforms" folder).